<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>SecurBot: patrolExecutive.py File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="securbotlogo_200x55.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SecurBot
   &#160;<span id="projectnumber">0.1</span>
   </div>
   <div id="projectbrief">A cutting edge robotic security platform</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_fe2f98e79845cc4fe8c694bed2318630.html">ros_pkg</a></li><li class="navelem"><a class="el" href="dir_684d670bf52a48c3b316c9fd056965cb.html">securbot_pkg</a></li><li class="navelem"><a class="el" href="dir_9d42a1615d542e1f4a0b12853648c04e.html">scripts</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">patrolExecutive.py File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpatrol_executive_1_1_status.html">patrolExecutive.Status</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacepatrol_executive"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html">patrolExecutive</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a19240022b9a69b09dd8759d33616e8d8"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a19240022b9a69b09dd8759d33616e8d8">patrolExecutive.waypointToPixelPoseStamped</a> (waypointObject)</td></tr>
<tr class="memdesc:a19240022b9a69b09dd8759d33616e8d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format Waypoint to Pixel PoseStamped.  <a href="namespacepatrol_executive.html#a19240022b9a69b09dd8759d33616e8d8">More...</a><br /></td></tr>
<tr class="separator:a19240022b9a69b09dd8759d33616e8d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a291bff7df650d9f38b4c5b521bcf117b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a291bff7df650d9f38b4c5b521bcf117b">patrolExecutive.pixelPoseStampedToRealPoseStamped</a> (pixelPoseStamped)</td></tr>
<tr class="memdesc:a291bff7df650d9f38b4c5b521bcf117b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publish Pixel PoseStamped to map_image_generator to format it into Real PoseStamped.  <a href="namespacepatrol_executive.html#a291bff7df650d9f38b4c5b521bcf117b">More...</a><br /></td></tr>
<tr class="separator:a291bff7df650d9f38b4c5b521bcf117b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97c5e5053d7b7eb75a5eb38cbe4cec6b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a97c5e5053d7b7eb75a5eb38cbe4cec6b">patrolExecutive.realPoseStampedReceiverCallback</a> (realPoseStamped)</td></tr>
<tr class="memdesc:a97c5e5053d7b7eb75a5eb38cbe4cec6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback funtion receiving processed waypoint from map_image.  <a href="namespacepatrol_executive.html#a97c5e5053d7b7eb75a5eb38cbe4cec6b">More...</a><br /></td></tr>
<tr class="separator:a97c5e5053d7b7eb75a5eb38cbe4cec6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a053fc2b8c4c45559e05ef75b84f3b570"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a053fc2b8c4c45559e05ef75b84f3b570">patrolExecutive.startPatrolNavigation</a> ()</td></tr>
<tr class="memdesc:a053fc2b8c4c45559e05ef75b84f3b570"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts sending the different waypoint that were converted in the list.  <a href="namespacepatrol_executive.html#a053fc2b8c4c45559e05ef75b84f3b570">More...</a><br /></td></tr>
<tr class="separator:a053fc2b8c4c45559e05ef75b84f3b570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b8c2b217b21f7b3a1dec024af3934b5"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a6b8c2b217b21f7b3a1dec024af3934b5">patrolExecutive.waypointsListReceiverCallback</a> (waypointsJsonStr)</td></tr>
<tr class="memdesc:a6b8c2b217b21f7b3a1dec024af3934b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback funtion that handles the reception of new patrol plans.  <a href="namespacepatrol_executive.html#a6b8c2b217b21f7b3a1dec024af3934b5">More...</a><br /></td></tr>
<tr class="separator:a6b8c2b217b21f7b3a1dec024af3934b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a116bc4ba9cdd430f99e6c9e1959157e0"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a116bc4ba9cdd430f99e6c9e1959157e0">patrolExecutive.interruptReceiverCallback</a> (interruptJsonStr)</td></tr>
<tr class="memdesc:a116bc4ba9cdd430f99e6c9e1959157e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interprets interruption requests.  <a href="namespacepatrol_executive.html#a116bc4ba9cdd430f99e6c9e1959157e0">More...</a><br /></td></tr>
<tr class="separator:a116bc4ba9cdd430f99e6c9e1959157e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a506e16c528993117bb64ac4d84ade632"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a506e16c528993117bb64ac4d84ade632">patrolExecutive.getStatusString</a> (uInt8Status)</td></tr>
<tr class="memdesc:a506e16c528993117bb64ac4d84ade632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns status as a string, used primarly for debugging purposes.  <a href="namespacepatrol_executive.html#a506e16c528993117bb64ac4d84ade632">More...</a><br /></td></tr>
<tr class="separator:a506e16c528993117bb64ac4d84ade632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52e09ea6ac1c05860facef17d809c3e5"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a52e09ea6ac1c05860facef17d809c3e5">patrolExecutive.publishPatrolFeedBack</a> (patrolId, status, acheivedWaypointCount, plannedWaypointCount)</td></tr>
<tr class="memdesc:a52e09ea6ac1c05860facef17d809c3e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes the advancement of a patrol.  <a href="namespacepatrol_executive.html#a52e09ea6ac1c05860facef17d809c3e5">More...</a><br /></td></tr>
<tr class="separator:a52e09ea6ac1c05860facef17d809c3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2748fed61621678f4ea0b3d732482ae9"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a2748fed61621678f4ea0b3d732482ae9">patrolExecutive.sendGoalDoneCallback</a> (terminalState, result)</td></tr>
<tr class="memdesc:a2748fed61621678f4ea0b3d732482ae9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function called when an action sent to move_base is done.  <a href="namespacepatrol_executive.html#a2748fed61621678f4ea0b3d732482ae9">More...</a><br /></td></tr>
<tr class="separator:a2748fed61621678f4ea0b3d732482ae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fa0e341e435a163ce0efbeda4cb08b3"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a1fa0e341e435a163ce0efbeda4cb08b3">patrolExecutive.patrolExecutive</a> ()</td></tr>
<tr class="memdesc:a1fa0e341e435a163ce0efbeda4cb08b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function starting the Patrol Executive Node.  <a href="namespacepatrol_executive.html#a1fa0e341e435a163ce0efbeda4cb08b3">More...</a><br /></td></tr>
<tr class="separator:a1fa0e341e435a163ce0efbeda4cb08b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a180a159337dbeb59ac203d3ac937f5f6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a180a159337dbeb59ac203d3ac937f5f6">patrolExecutive.PIXEL_POSESTAMPED_INDEX</a> = 1</td></tr>
<tr class="separator:a180a159337dbeb59ac203d3ac937f5f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75b5593940d99021aeee363eadc8f039"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a75b5593940d99021aeee363eadc8f039">patrolExecutive.REAL_POSESTAMPED_INDEX</a> = 2</td></tr>
<tr class="separator:a75b5593940d99021aeee363eadc8f039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c84d05f959175af3eb8b11c81d71a99"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a6c84d05f959175af3eb8b11c81d71a99">patrolExecutive.actionClient</a> = actionlib.SimpleActionClient('move_base', MoveBaseAction)</td></tr>
<tr class="separator:a6c84d05f959175af3eb8b11c81d71a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5012d6c6e1f67b98385f4ffab8b677f"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#ac5012d6c6e1f67b98385f4ffab8b677f">patrolExecutive.waypointsPatrolList</a> = []</td></tr>
<tr class="separator:ac5012d6c6e1f67b98385f4ffab8b677f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ad7674bddfa1ae554aba971d3fc60ca"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a8ad7674bddfa1ae554aba971d3fc60ca">patrolExecutive.currentWaypointIndex</a> = 0</td></tr>
<tr class="separator:a8ad7674bddfa1ae554aba971d3fc60ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afffb19bc289301a6eb58e0edca10391e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#afffb19bc289301a6eb58e0edca10391e">patrolExecutive.isLooped</a> = False</td></tr>
<tr class="separator:afffb19bc289301a6eb58e0edca10391e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc3900570327f4100816af6d160d9528"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#afc3900570327f4100816af6d160d9528">patrolExecutive.patrolId</a> = &quot;&quot;</td></tr>
<tr class="separator:afc3900570327f4100816af6d160d9528"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0127a20e1aa0b2e6107e2cf643b30068"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a0127a20e1aa0b2e6107e2cf643b30068">patrolExecutive.toMapImageGenerator</a> = rospy.Publisher(&quot;toMapImageGenerator&quot;, PoseStamped, queue_size=20)</td></tr>
<tr class="separator:a0127a20e1aa0b2e6107e2cf643b30068"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a561e58b7fc32f992655a0d0f66393629"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepatrol_executive.html#a561e58b7fc32f992655a0d0f66393629">patrolExecutive.toElectron</a> = rospy.Publisher(&quot;toElectron&quot;, String, queue_size=20)</td></tr>
<tr class="separator:a561e58b7fc32f992655a0d0f66393629"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
